-
-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Add notes that doc lookup requires REPL #52065
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This feels kind of unfortunate to me. These don't really feel "REPL"y and you might want to use these programatically in many contexts that don't require a REPL, or? |
CC @vchuravy Maybe we need the If folks want to excise the repl and still lookup documentation then maybe it makes sense to make a new "Docsystem" stdlib, but I think that is low priority. |
While this dependency on |
Since the REPL stdlib is no longer included in the sysimg, doc lookup with `@doc`, `apropos`, and `Base.Docs.doc` only works if the REPL stdlib is loaded. Therefore, compat admonitions are added in several places.
9c66522
to
1b5f049
Compare
Updated to resolve the conflicts. |
Merging this does not preclude enabling usage of these functions without REPL and does not indicate that we don't want that solution. Just documenting reality now. |
Indeed, we still have issues like #54664 about this |
Documentation lookup with
@doc
,apropos
, andBase.Docs.doc
is exported byBase
, but the actual implementation lives in the REPL. Since the REPL is no longer included in the sysimg, these functions only work if the REPL stdlib is loaded explicitly. This PR adds compat admonitions in several places.